************
INTRODUCTION
************

This file describes how to set up and use the Ruby wrapper code with Melissa DATA's Phone Object.


*************
PREREQUISITES
*************

To make use of the Phone Object Ruby wrapper you will need:

* An installation of a Ruby. This Wrapper tested with Ruby 1.8.6.

* The Melissa DATA Phone Object library and data files installed.
  These files are installed automatically if you run setup.exe. By default, the Phone Object 
  Library (mdPhone.dll) is installed in:
	C:\Program Files\Melissa DATA\DQT\PhoneObj\dll_32bit
* 64bit version available in C:\Program Files\Melissa DATA\DQT\PhoneObj\dll_64bit


  and the Phone Object data files in:
	C:\Program Files\Melissa DATA\DQT\Data

You will need to know the location of these items in order to install and run the Ruby wrapper.

**********************
Wrapper compatibility
**********************

If the provided pre-compiled wrappers are not compatible with your environment, the necessary files for compilation can be found in the 'interfaces' folder of the object's main directory.


***********
Demo Mode
***********

Please contact your sales representative to unlock Phone Object. Without a valid license, Phone Object 
will only validate Nevada phone numbers. Please call 1-800-MELISSA ext. 3 for more information.


*************
Installation
*************

Copy the entire folder that contains this readme.txt into a local directory on your computer.


*****
Setup
*****

You will need to allow mdPhoneRubyWrapper.dll to find mdPhone.dll. You can do this by:

	1. Adding the directory containing mdPhone to your PATH environment variable. 
	   ex: set PATH=%PATH%;C:\Program Files\Melissa DATA\DQT\PhoneObj\dll_32bit

* 64bit version available in C:\Program Files\Melissa DATA\DQT\PhoneObj\dll_64bit

	or

	2. Copy mdPhone.dll into the directory with mdPhoneRubyWrapper.dll.



**************************
Setting up the Sample Code
**************************

Open mdPhoneTest.rb for editing. You must set the a license string that you receive from your Melissa Data
sales representative and the path to the mdPhone data files.

License = "demo"
DataPath = "C:\\Program Files\\Melissa Data\\DQT\\Data"

***********************
Running the Sample Code
***********************

Navigate to the directory containing the Ruby wrapper using command line and type:
	ruby mdPhoneSample.rb

*******
Updates
*******

The files generated/included in this wrapper do not need to be changed for DQ Suite updates unless there is a method signature change in the object. If a new method is added, you will need to rebuild the wrapper to use the new method. 

****
Note
****

Here are some general solutions if you run into problems:

Q. I get an error saying "can't find mdPhone.dll" or "Entry Point Not Found."
A. This means that mdPhoneRubyWrapper.dll cannot link to mdPhone.dll. Please follow the steps in
the Setup section above.



COPYRIGHT NOTICE

(C) 2014 Melissa Data Corporation. All rights reserved.
